////////////////////////////////////////////////////////////////////////////////
// This file is part of the Mist compiler.                                    //
//                                                                            //
// Copyright (C) 2009 The Mist project                                        //
//                                                                            //
// For a list of contributors, see the COMMITTERS file.                       //
//                                                                            //
// The Mist compiler is free software: you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by       //
// the Free Software Foundation, either version 3 of the License, or          //
// (at your option) any later version.                                        //
//                                                                            //
// The Mist compiler is distributed in the hope that it will be useful,       //
// but WITHOUT ANY WARRANTY; without even the implied warranty of             //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              //
// GNU General Public License for more details.                               //
//                                                                            //
// You should have received a copy of the GNU General Public License          //
// in the COPYING file. If not, see <http://www.gnu.org/licenses/>.           //
////////////////////////////////////////////////////////////////////////////////

///
/// \file
/// Contains the Navigator class.
///

#ifndef NAVIGATOR_HPP
#define NAVIGATOR_HPP

////////////////////////////////////////////////////////////////////////////////
// Includes                                                                   //
////////////////////////////////////////////////////////////////////////////////

#include "common/ptr.hpp"
#include "nodes.hpp"
#include "visitor.hpp"

////////////////////////////////////////////////////////////////////////////////
// Forward Declarations                                                       //
////////////////////////////////////////////////////////////////////////////////

CLASSES_FROM( CONCRETE_NODES )

////////////////////////////////////////////////////////////////////////////////
// Navigator Class                                                            //
////////////////////////////////////////////////////////////////////////////////

/// If an AST visitor class inherits from Navigator instead of Visitor, it can
/// define exactly those visitor functions it needs, and be sure that all nodes
/// in the AST with that type will be reached. The Navigator class does nothing
/// but propagate visits through the entire tree.
///
/// Note that if you overwrite a visit function, you are responsible for
/// visiting the children of each node of that type. But, for convenience,
/// you may do so by calling <tt>Navigator::visit(node);</tt>.
///
class Navigator : public Visitor {
	public:
		
		virtual ~Navigator() {}
		
		VIRTUAL_VISIT_FUNCTIONS_FROM( CONCRETE_NODES )
};

#endif // NAVIGATOR_HPP
